home *** CD-ROM | disk | FTP | other *** search
/ Aminet 30 / Aminet 30 (1999)(Schatztruhe)[!][Apr 1999].iso / Aminet / comm / maxs / mp2.lha / MaxsPro2ArexxList.Txt < prev    next >
Text File  |  1998-02-28  |  11KB  |  314 lines
  1. Commands marked * are not implemented in /X\2
  2.  
  3.  
  4.           A r e x x  C o m m a n d  L i s t  F o r  M a x s P r o 2
  5.           =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-==-=-=-=-=-=-=-=-=-=-=-=-=-
  6.  
  7.                       By Lars Werner (Alias: Large/MRW)
  8.  
  9. Some of the descriptions on the commands are taken from Cnet Arexx
  10. Commandlist made by Le Chat. All examples that are in the list is made by me.
  11. There is no guarantee that all information in this list works.
  12.  
  13. All script that are made to MaxsPro2 can begin like this:
  14.  
  15. [---------------------------------Example-----------------------------------]
  16.  
  17. /* Mpro2 Arexx Header */
  18.  
  19. PARSE ARG PortName
  20. Address Value 'M2REXX' || PortName
  21. Options Results
  22.  
  23. [------------------------------End of Example-------------------------------]
  24.  
  25. (The "options results" is not needed but if you for example want to use the
  26. GETUSER command it must give the results)
  27.  
  28. Commands:
  29.  
  30. A:
  31.  
  32.         ADDKEYS {string} - Adds a  string  of  characters  into  the port's
  33.                            input buffer.  This can be useful for automating
  34.                            logons or pre-inputting  data  (i.e.  if  a game
  35.                            asks a user for  a  handle  to use for the game,
  36.                            prior to receiving or querying for the handle an
  37.                            ADDKEYS call can input the user's current handle
  38.                            as  a  default).   Use  d2c(13)  or  d2c(10)  to
  39.                            represent a carriage return.
  40.  
  41.         ADDTIME {string} - Adds a  number  of  minutes  to  the user's time
  42.                            remaining  for  the  total  day.   Use  negative
  43.                            numbers to subtract.
  44.  
  45. B:
  46.  
  47.         BAUD {number} - Set the current baud rate to {number}
  48.  
  49. *        BBSCOMMAND {string} - Attempt to  execute  a  BBS command {string}.
  50.                               The   command   must    be    an   all-prompt
  51.                               (everywhere) command  such  as  B to go to the
  52.                               bulletins menu. (The setup may be different on
  53.                               every BBS!!)
  54.  
  55.         BBSIDENTIFY {argument} - Returns  the  following   for   the  given
  56.                                  arguments:
  57.  
  58.                   {argument}      RESULT
  59.                   ABBEREXX        "4.1"
  60.                   BBS             Current MaxsPro2 version
  61.                   EMULATION       "ASCII" or "ANSI"
  62.                   NAME            Your BBS's name as set in CONFIG
  63.                   SYSOP           SysOp's name as set in CONFIG
  64. *                  TERM            <baud> <columns> <rows> <line>
  65.                   USER            "<username>" "<callingfrom>" <access>
  66.                                   <access> will be GUEST for new users
  67.                                   MEMBER for other users
  68.                                   SYSOP for account #1
  69.                                   CO-SYSOP  for  accounts  with maintenance
  70.                                   access
  71.  
  72.         BUFFERFLUSH - Will flush the current buffer in M2REXX<node>.
  73.  
  74. C:
  75.  
  76.         CHANGEWHERE {string} - Set the user's ACTION  field  in the WHO and
  77.                                Control Panel.
  78.  
  79.         CHECKABORT - Returns a one  if  a  user  has  pressed  Control-C or
  80.                      SPACEBAR, and a  zero  otherwise.   Each time there is
  81.                      output this will be reset, so you should only use this
  82.                      command  immediately  after  sending  out  data  (i.e.
  83.                      immediately after a SENDFILE and the like).
  84.  
  85.         CLS - Sends the clear screen code.
  86.  
  87. D:
  88.  
  89.         DEICONIFY - Deiconify M2REXX<node> if it was iconifyed.
  90.         
  91.  
  92.         DROPCARRIER - Disconnects the  caller,  but  does  not  perform any
  93.                       additional reset commands.
  94.  
  95. E:
  96.  
  97.         EXITDOOR - Exiting a script that are called with the function 45 in 
  98.                    the menu, you can also use EXIT.
  99.  
  100. F:
  101.  
  102.         FILELIST {number} - Shows marked filename (Given marked number)
  103.  
  104.  
  105. G:
  106.  
  107.         GETCHAR - Pauses for a character to  enter the port's input buffer.
  108.                   The key will be placed into RESULT.  See also MAYGETCHAR.
  109.  
  110.         GETUSER {number} - Used to pull  various  pieces  of  the user data
  111.                            file into the  RESULT variable.   The  number may
  112.                            take on the following values:
  113.  
  114.          Number#       RESULT
  115.          --------------------
  116.                1       User's Handle
  117.                2       User's Password
  118.                3       Users's full real name
  119.                4       User's City and State
  120.                7       Time remaining (minutes)
  121.                8       SysOp Comment
  122.                9       User's Voice Phone Number
  123.                10      User's Data Phone Number
  124.                12      Current date and time (affected by Edit Preferences'
  125.                        Time Zone!)
  126.                13      Number of mail items waiting
  127.                15      User's access group (0-23)
  128.                17      System maintenance.  0==No,  anything else==Yes
  129.                18      Number of minutes used today
  130.                19      Screen clear code (returns 12==`L)
  131.                22      Total calls to the system by user
  132.                23      The current port number
  133.                24      The current CPS (baud rate divided by ten)
  134.                25      User's FILE RATIO default (#1)
  135.                26      User's BYTE RATIO default (#1)
  136.                27      Current line width (e.g. 40 or 80)
  137.                28      Terminal type (0=Dumb, 1=C/G, 2=ANSI, 3=IBM, 4=Sky)
  138.                30      Total uploaded kbytes
  139.                31      Total uploaded files
  140.                32      Total downloaded kbytes
  141.                33      Total downloaded files
  142.                34      File credits
  143.                35      Byte credits
  144.                36      Total public messages
  145.                37      Total private messages
  146.                40      User's account number
  147.                41      User's unique ID number
  148.                
  149.                70      MCI string contents
  150.                95      Total calls
  151.                96      Active files online
  152.  
  153.  
  154.         GETMAXSNUMBER {number} - Used to pull  various  pieces  of  the user data
  155.                                file into the  RESULT variable.   The  number may
  156.                                take on the following values:
  157.  
  158.          Number#       RESULT
  159.          --------------------
  160.                1       User's access level
  161.                2-3     *Private*
  162.                4       User calls
  163.                5       Total calls to BBS
  164.                6       GFX Emulation (Always returns 3 (ANSI))
  165.                7       Minutes remaining
  166.                8       Terminal width (Always 80)
  167.                9       Terminal length
  168.                100     Time Limit
  169.                101     File Ratio
  170.                102     Last msg read
  171.                103     Messages written
  172.                104     Files uploaded
  173.                105     Files downloaded
  174.                106     Date last on (Date stamp)
  175.                107     Time last on (Time stamp)
  176.                108     User flags
  177.                109     Time bank
  178.                110     Transfer protocol (0-6)
  179.                111     Max time bank
  180.                
  181.  
  182.  
  183.  
  184. H:
  185.  
  186.         HANGUP - Same as DROPCARRIER.
  187.  
  188. I:
  189.  
  190.         ICONIFY - Iconify current M2REXX<node>
  191.  
  192.         INTERNAL - ONLY for the menu replacement rexx scripts!
  193.                  Jumps back into the original menu command being replaced.
  194.  
  195. L:
  196.  
  197.         LOCAL_LOGIN - If the node is "userless" it will make a local login at
  198.                       the M2REXX<node>.
  199.  
  200.         LOCATEFILE {file} - Tell you where the {file} is.
  201.  
  202.         LOGENTRY {string} - Writes a string  into  your  call  log (no need
  203.                             terminate the line  with  a  carriage return or
  204.                             line feed).
  205.  
  206. M:
  207.  
  208.         MARKED_FILES - Returns the amount of marked files a user has.
  209.  
  210.         MAYGETCHAR - Returns the waiting-input character or "NOCHAR" if the
  211.                      input buffer is empty.
  212.  
  213.         MENUFUNC - 'Function,Extra,String' - Execute a menucommand and give 
  214.                                              the result on the screen
  215.  
  216.         MODEMOUT - Displays text to the remote user ONLY.
  217.  
  218.  
  219. N:
  220.  
  221.         NEWLINE - Sends the newline code.
  222.  
  223. O:
  224.  
  225.     OFFLINE - Puts the max's node into Sleep mode.
  226.     
  227.     ONLINE - Takes the max's node off sleep mode.
  228.  
  229.  
  230. P:
  231.  
  232.         PRINT {string} - Same as TRANSMIT.
  233.  
  234.         PROMPT <length> {argument} '<prompt>'
  235.                <length> is the maximum number of characters to input.
  236.                {argument} is one of:
  237.                      NORMAL
  238.                      HIDE      : password input
  239.                      YESNO     : Yes/No with Yes as default
  240.                      NOYES     : Yes/No with No as default
  241.  
  242.                The argument MUST be written, the NORMAL is not a default!
  243.  
  244.                The result will contain the inputted string.
  245.  
  246. Q:
  247.  
  248.         QUERY {string} - Uses the supplied string  as  a prompt; otherwise,
  249.                          this command is identical to RECEIVE.
  250.  
  251.         QUIT - If this is sendt to the M2REXX<Node> port when there is NOT a
  252.                script active it will QUIT the current <node>
  253.  
  254. R:
  255.     RECIEVE - Waits for a string of text to be inputted.
  256.  
  257.  
  258. S:
  259.  
  260.         SCREENOUT {string} - Displays a string, but  only to the screen and
  261.                              not to the modem.
  262.  
  263.         SENDFILE {path} - Displays the text file  specified by the supplied
  264.                           path and filename.   MCI  codes  and ANSI will be
  265.                           interpreted.
  266.  
  267.         SENDSTRING {string} - Identical  to  TRANSMIT  except  it  will not
  268.                               append a carriage return (advance to the next
  269.                               line automatically)
  270.  
  271.         SEND {string} - Send the passed string  without  any translation of
  272.                         any kind.  (no MCI, etc.)
  273.  
  274. T:
  275.  
  276.         TRANSMIT {string} - Sends the string  to  the  screen and modem.  A
  277.                             carriage   return   is   added   to   the   end
  278.                             (automatically advances to the next line).
  279.  
  280. X:
  281.  
  282.         XDN {path} - This command will send the specified path and filename
  283.                      to the  user. This is a free download!
  284.  
  285.         XUP {path} - Like XDN but it only need only a path. This is free 
  286.                      upload!
  287.  
  288.  
  289.  
  290.         Notes:
  291.         ======
  292.  
  293.         QUERY,   GETCHAR,  MAYGETCHAR,   and  PROMPT  will  return
  294.         ###PANIC if the user has dropped  carrier or run out of time.  Make
  295.         your scripts robust by always checking for this result.
  296.  
  297.  
  298.  
  299.         Last words from the author:
  300.         ==========================
  301.  
  302.         You can contact Lars Werner (Alias: Large/MRW) by sending E-Mail to:
  303.  
  304.         large@Write.Com
  305.  
  306.         Or by calling my BBS at:
  307.  
  308.         MEZZY BBS: +47 35961626!
  309.  
  310.         Other information and stuff, Call WiseGuy at:
  311.  
  312.         OUTER SPACE #1: +47 62420514
  313.         OUTER SPACE #2: +47 62420591
  314.